Skip to main content
Version: 2.0.0

How to Design a Workflow

Step 1: Create a New Workflow Model

  • Use the workflow designer to create a new model
  • Give it a name and key
  • Add a description

Step 2: Design the Flow

Using the visual editor, you can add:

  • Start Event
  • User Tasks
  • Script Tasks
  • HTTP Tasks
  • Gateways
  • Message Events
  • Receive Tasks
  • End Event

Step 3: Create Forms

  1. Design the form with the form builder
  2. Available field types:
    • Text
    • Dropdown
    • Radio Buttons
    • Date Picker
    • Check Box
    • Table
  3. Mark fields as required or read-only
  4. Define outcomes
  5. Link the form to the user task using the form key

Step 4: Create an Application

  • Create an App model
  • Associate workflow model with the app
  • Set application ID

Step 5: Deploy

  • Click deploy
  • Forms are published to the task center

Starting a New Process

  1. Select the workflow
  2. Fill out the start form
  3. Click submit
  4. The system creates a new process instance

Working on Tasks

  1. Open your task inbox
  2. View assigned tasks
  3. Claim a task
  4. Fill out the form
  5. Click an outcome button

Task Actions

ActionWhat it Does
ClaimTake ownership of a group task
ReleaseGive up a claimed task
ForwardReassign the task
CompleteSubmit your decision/data

Viewing Process Information

You can view:

  • Process diagram
  • Process variables
  • Task history

Functional Flow

DESIGN TIME
1. Create Workflow Model
2. Design BPMN
3. Create Forms
4. Create App Container
5. Link Model to App
6. Deploy

RUNTIME
7. Start Process
8. Tasks Created
9. Users Claim/Complete
10. Gateways Route
11. Next Tasks
12. Process Ends

API Call Sequence

Design & Deploy a Workflow

1. POST /api/models/create
2. PUT /api/models/{id}/json
3. POST /api/models/createForm
4. POST /api/models/create
5. PUT /api/models/app-definitions/{appId}
6. POST /api/models/deploy/{modelId}/{appId}

Run a Process

1. POST /startProcessWithForm
2. GET /taskByProcessInstanceId/{id}
3. POST /forwardOrClaimTask/{taskId}/{user}
4. POST /completeTaskWithForm
5. GET /processInstanceData/{id}